home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / wb / czesc_1 / cgwbpattern101 / ilbmtoppm.lha / manual / ppmtoilbm.man < prev   
Text File  |  1995-04-13  |  12KB  |  397 lines
  1.  
  2.  
  3.  
  4.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  5.  
  6.  
  7.  
  8.      NAME
  9.           ppmtoilbm - convert a portable pixmap into an IFF-ILBM,
  10.           IFF-RGBN or IFF-RGB8 file
  11.  
  12.      SYNOPSIS
  13.           ppmtoilbm [-ilbm|-rgb8 |-rgbn] [-ecs|-aga] [-ham6|-ham8]
  14.           [-maxplanes|-mp N] [-fixplanes|-fp N] [-normal
  15.           |-hamif|-hamforce |-24if|-24force |-deepif|-deepforce
  16.           |-dcif|-dcforce |-cmaponly] [-hambits|-hamplanes N] [-hammap
  17.           mode] [-deepbits|-deepplanes N] [-dcbits|-dcplanes N]
  18.           [-annotation string] [-author string] [-copyright string]
  19.           [-name string] [-text string] [-hires] [-lace] [-camg
  20.           hexval] [-nocompress] [-cmethod method] [-mapfile ppmfile]
  21.           [-sortcmap] [-floyd|-fs] [-mmethod method] [-maskfile
  22.           pbmfile] [-transparent color] [ppmfile]
  23.  
  24.      DESCRIPTION
  25.           Reads a portable pixmap as input.  Produces an IFF-ILBM,
  26.           IFF-RGB8 or IFF-RGBN file as output.  Supported ILBM types
  27.           are:
  28.  
  29.           Normal ILBMs
  30.                1-16 planes, with colormap.  Amiga display mode Hold-
  31.                any-modify (HAM) is supported, with 3-10 planes
  32.                (including the 2 control planes).
  33.  
  34.           Deep ILBMs
  35.                3-48 planes, direct RGB encoding. Usually 24 planes are
  36.                used (for 8-bit RGB values).
  37.  
  38.           Direct color ILBMs
  39.                3-48 planes, direct RGB encoding.  This is an
  40.                experimental format that supports a different number of
  41.                planes for each color component.
  42.  
  43.           Colormap files
  44.                BMHD + CMAP chunk only, 0 planes.
  45.  
  46.      OPTIONS
  47.           Options marked with (*) can be prefixed with a "no", e.g.
  48.           '-nohamif'.  Most options can only be used for IFF-ILBM
  49.           files, if an option is usable with IFF-RGBN and IFF-RGB8 it
  50.           is noted in the description.  All options can be abbreviated
  51.           to their shortest unique prefix.
  52.  
  53.  
  54.           -ilbm | -rgb8 | -rgbn
  55.                Write an IFF-ILBM, IFF-RGB8 or IFF-RGBN file. The
  56.                default is IFF-ILBM.
  57.  
  58.  
  59.           -maxplanes N
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/13/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  71.  
  72.  
  73.  
  74.                Maximum planes to write in a normal ILBM.  If the
  75.                pixmap does not fit into N planes, ppmtoilbm writes a
  76.                HAM file (if -hamif is used), a deep file (if -deepif
  77.                is used), or a direct color file (if -dcif is used), or
  78.                aborts with an error.  The default value is 5 planes
  79.                (for backwards compatibility), minimum value is 1 and
  80.                maximum 8. This option can be abbreviated to -mp.
  81.  
  82.  
  83.           -fixplanes N
  84.                If a normal ILBM is written, it will have exactly N
  85.                planes, even if the number of colors would fit into
  86.                fewer planes. This option can be abbreviated to -fp.
  87.  
  88.  
  89.           -hamplanes N
  90.                Set the number of planes (including the two control
  91.                planes) for a HAM picture.  The current Amiga hardware
  92.                supports 6 and 8 planes, so for now you should use only
  93.                these values. The default value is 6 (for backwards
  94.                compatibility), minimum value is 3, maximum 10.
  95.  
  96.  
  97.           -hambits N
  98.                Set the number of bits for a color component or index
  99.                value in a HAM picture.  This is the same as -hamplanes
  100.                N+2
  101.  
  102.  
  103.           -hammap mode
  104.                Select HAM colormap.  The default mode is gray for a
  105.                grayscale colormap.  This mode is fastest and all
  106.                images of the same depth (number of planes) use the
  107.                same colormap, which is useful for building animations.
  108.                The mode fixed uses a fixed RGB colormap, evenly
  109.                distributed pixels on the seven primary color rays
  110.                (red, green, blue, yellow, magenta, cyan and gray).
  111.                This mode can also be used for animations, but it is
  112.                much slower than gray. The modes rgb4 and rgb5 compute
  113.                an individial colormap for the image, using a simple
  114.                algorithm for clustering colors in RGB space.  These
  115.                modes give the best results, but are very slow.  rgb4
  116.                uses a 12-bit lookup table (4 bits per color
  117.                component), rgb5 a 15-bit table (5 bits per color
  118.                component).
  119.  
  120.  
  121.           -deepplanes N
  122.                Set the number of planes for a deep ILBM.  N must be
  123.                divisible by 3.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/13/95)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  137.  
  138.  
  139.  
  140.           -deepbits N
  141.                Set the number of bits for a color component in a deep
  142.                ILBM.  This is the same as -deepplanes 3*N
  143.  
  144.  
  145.           -dcbits r g b | -dcplanes r g b
  146.                Set the number of bits for a color component in a
  147.                direct color ILBM.
  148.  
  149.  
  150.           -normal
  151.                Turns off -hamif, -24if, -hamforce, -24force, -deepif,
  152.                -deepforce and -cmaponly and sets compression type to
  153.                byterun1. This is the default mode for IFF-ILBM files.
  154.  
  155.  
  156.           -hamif (*) | -deepif (*) | -dcif (*)
  157.                Write a HAM/deep/direct color file if the pixmap does
  158.                not fit into the maximum number of planes as given by
  159.                the -maxplanes option.
  160.  
  161.  
  162.           -hamforce (*) | -deepforce (*) | -dcforce (*)
  163.                Write a HAM/deep/direct color file, even if the number
  164.                of colors would fit in a normal ILBM.  Enforcing deep
  165.                or direct color format allows stream-reading of the
  166.                image file, as does HAM with gray colormap mode.
  167.  
  168.  
  169.           -24force (*)
  170.                Shortcut for -deepplanes 8 -deepforce
  171.  
  172.  
  173.           -24if (*) (default)
  174.                Shortcut for -deepplanes 8 -deepforce
  175.  
  176.  
  177.           -cmaponly
  178.                Write a colormap file: only BMHD and CMAP chunks, no
  179.                BODY chunk, nPlanes = 0.
  180.  
  181.  
  182.           -ecs | -aga
  183.                Set the appropriate -hamplanes and -maxplanes values
  184.                for the Amiga ECS or AGA chipset.  ECS values are used
  185.                by default for backwards compatibility.
  186.  
  187.  
  188.           -ham6
  189.                Write a HAM picture with 6 planes.  This is a shortcut
  190.                for -hamforce -hamplanes 6
  191.  
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/13/95)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  203.  
  204.  
  205.  
  206.           -ham8
  207.                Write a HAM picture with 8 planes.  This is a shortcut
  208.                for -hamforce -hamplanes 8
  209.  
  210.  
  211.           -annotation string
  212.  
  213.           -author string
  214.  
  215.           -copyright string
  216.  
  217.           -name string
  218.  
  219.           -text string
  220.                Write an IFF annotation, author, copyright, name and/or
  221.                text chunk (IDs "ANNO", "AUTH", "(c) ", "NAME", and
  222.                "TEXT") into the output file.  These are generic IFF
  223.                text chunks and can be used for all file formats.
  224.  
  225.  
  226.           -hires (*), -lace (*)
  227.                Sets the HIRES and LACE bits in the CAMG chunk and
  228.                adjusts BMHD.xAspect/BMHD.yAspect accordingly. Other
  229.                bits might be set in the CAMG chunk depending on other
  230.                options.  These options can be used with IFF-RGBN and
  231.                IFF-RGB8 files.
  232.  
  233.  
  234.           -camg hexval
  235.                Write a specific value into the CAMG chunk.  The
  236.                hexadecimal value can be given with or without a 0x
  237.                prefix. Other bits might be set in the CAMG chunk
  238.                depending on other options.  This option can be used
  239.                with IFF-RGBN and IFF-RGB8 files.
  240.  
  241.  
  242.           -nocompress
  243.                Do not compress the BODY chunk.  Compression requires
  244.                building the ILBM image in memory; turning compression
  245.                off allows stream-writing of the image, but the
  246.                resulting file will usually be 30% to 50% larger. This
  247.                options affect only IFF-ILBM files, IFF-RGBN and IFF-
  248.                RGB8 files are always compressed using a pixel repeat
  249.                count.
  250.  
  251.  
  252.           -cmethod method
  253.                Select compression method.  Default is byterun1.
  254.                Setting method to none is equivalent to using a
  255.                -nocompress option.  method can be abbreviated to the
  256.                shortest unique prefix.  Numeric values (0, 1) are also
  257.                accepted.
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/13/95)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  269.  
  270.  
  271.  
  272.           -mapfile ppmfile
  273.                Use the colors in ppmfile as the colormap when writing
  274.                an a normal or HAM ILBM file.  The mapfile is a normal
  275.                PPM image, it can be any shape, all that matters are
  276.                the colors in it, and the order they appear in.  If the
  277.                colors in the input file do not match those in ppmfile,
  278.                they are matched to a "best match", the "if"-options
  279.                have no effect.  Using a mapfile allows stream-reading
  280.                of the image.
  281.  
  282.  
  283.           -sortcmap
  284.                Sort the colormap.
  285.  
  286.  
  287.           -mmethod method
  288.                Select masking method for ILBM files.  method can be
  289.                none
  290.                 (no masking, default), maskplane and transparentcolor
  291.                (only for normal ILBMs) lasso masks are are not
  292.                supported yet.  method can be abbreviated to the
  293.                shortest unique prefix.  Numeric values (0, 1, 2, 3)
  294.                are also accepted.
  295.  
  296.  
  297.           -maskfile pbmfile
  298.                Use a mask file to mark transparent pixels in an IFF-
  299.                ILBM.  If the -mmethod option is not used, masking
  300.                method is set to maskplane. pbmfile is a normal PBM
  301.                image, the same size (or larger) as the input file.  A
  302.                pixel value of PBM_WHITE in the mask file means the
  303.                corresponding in the input file is considered to be
  304.                transparent, PBM_BLACK indicates an opaque pixel (think
  305.                of the input file casting a shadow on a white screen).
  306.                In an IFF-RGBN or IFF-RGB8 file, the mask file is used
  307.                to set the genlock bits.
  308.  
  309.  
  310.           -transparent color
  311.                Mark the given color as transparent.  The color is
  312.                specified as in ppmmake(1).  If the -mmethod options is
  313.                not used, masking method is set to transparentcolor.
  314.  
  315.  
  316.           -floyd (*) | -fs (*)
  317.                Use Floyd-Steinberg error diffusion for mapping the
  318.                input colors to HAM or to the colors in a mapfile.  The
  319.                results are usually much better than without it, but it
  320.                takes substantially more CPU time, so the default is
  321.                off.
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/13/95)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.      ppmtoilbm(1)         AMIGA (23 October 1994)         ppmtoilbm(1)
  335.  
  336.  
  337.  
  338.      BUGS
  339.           Not all image types that are supported by ilbmtoppm can be
  340.           generated with ppmtoilbm.
  341.  
  342.  
  343.      REFERENCES
  344.           Amiga ROM Kernel Reference Manual - Devices (3rd Ed.),
  345.           Addison Wesley, ISBN 0-201-56775-X, Appendix A: Interchange
  346.           File Format
  347.  
  348.  
  349.      SEE ALSO
  350.           ppm(5), ilbmtoppm(1)
  351.  
  352.  
  353.      AUTHORS
  354.           Copyright (C) 1989 by Jef Poskanzer.
  355.           Modified 1993/1994 by Ingo Wilken
  356.           (Ingo.Wilken@informatik.uni-oldenburg.de)
  357.  
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.      Page 6                                          (printed 4/13/95)
  394.  
  395.  
  396.  
  397.